Fix hash capitalization in API links #2204
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Eric-Arellano
commented
Oct 29, 2024
| @@ -26,10 +26,11 @@ test.describe("updateLinks", () => { | |||
| [link3](qiskit_ibm_runtime.RuntimeJob.job#wut) | |||
| [link4](../stubs/qiskit_ibm_runtime.RuntimeJob) | |||
| [link5](../apidocs/qiskit_ibm_runtime.RuntimeJob#qiskit_ibm_runtime.RuntimeJob) | |||
| [link6](qiskit_ibm_runtime.RuntimeJob) | |||
There was a problem hiding this comment.
I added a new link 6, so updated the link numbers for all these
Comment on lines
-112
to
-114
| // Anchors generated from markdown headings are always lower case but, if these | ||
| // headings are API references, Sphinx sometimes expects them to include | ||
| // uppercase characters. |
There was a problem hiding this comment.
This came from the helper function lowerCaseIfMarkdownAnchor. I accidentally didn't delete it last PR. Its implementation was more robust so I use that rather than inlining
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #2177. We weren't normalizing the hash in all cases.